Platform Explorer / Nuxeo Platform 2023.23

Operation User.Query (Query users)

Description

Query users on a combination of their username, firstName and lastName fields, or on any of them (pattern).
Operation id User.Query
AliasesServices.QueryUsers
Category Users & Groups
Label Query users
Requires
Since

Parameters

Name Description Type Required Default value
firstName string no  
lastName string no  
pattern string no  
tenantId string no  
username string no  

Signature

Inputs void
Outputs blob

Implementation Information

Implementation Class Class: org.nuxeo.ecm.automation.core.operations.users.QueryUsers
Contributing Component org.nuxeo.ecm.core.automation.features.operations

JSON Definition

{
  "id" : "User.Query",
  "aliases" : [ "Services.QueryUsers" ],
  "label" : "Query users",
  "category" : "Users & Groups",
  "requires" : null,
  "description" : "Query users on a combination of their username, firstName and lastName fields, or on any of them (pattern).",
  "url" : "User.Query",
  "signature" : [ "void", "blob" ],
  "params" : [ {
    "name" : "firstName",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "lastName",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "pattern",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "tenantId",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "username",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  } ]
}